Resource Path: /api/agent
Uri: http://doc.jamsscheduler.com/api/agent
Description
Updates an existing Agent object or creates a new definition if it doesn't exist.
Request
The request body is of type Agent.
The name of the agent
Overview
 |
Agent
 |
agentName : string
|
|
agentTypeName : string
|
|
agentType : string
|
|
platformTypeName : string
|
|
agentPlatform : string
|
|
agentID : integer
|
|
description : string
|
|
lastChangeUTC : string
|
|
lastChangedBy : string
|
|
jobCount : integer
|
|
jobLimit : integer
|
|
licenseAllocated : boolean
|
|
licenseRequired : boolean
|
|
online : boolean
|
|
version : string
|
|
timeOffset : string
|
|
agentState : string
|
 |
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
isExecutionAgent : boolean
|
 |
|
|
identifier : string
|
|
inherited : boolean
|
|
flags : string
|
 |
accessList : Array[string]
|
|
|
|
Response
The response body is of type string.
OK
See Also